Vercel
API ReferenceChats

List Chats

Lists chats accessible to the authenticated user. Use metadata[key]=value style query parameters to filter by metadata.

GET/v2/chats

Usage

TypeScript Example
import { v0 } from 'v0-sdk'const result = await v0.chats.list()console.log(result)

API Signature

Request

Query Parameters

limit?: integer

Maximum number of chats to return (1-100, default 20).

cursor?: string

Pagination cursor returned from a previous response.

authorId?: string

Restrict results to chats created by this user. Must be a member of the calling scope.

vercelProjectId?: string

Restrict results to chats associated with this Vercel project.

metadata?: Record<string, string>

Filter by metadata, e.g. metadata[environment]=production. Returns chats matching all supplied key-value pairs.

Response

chats: object[]

The chats in this page.

id: string

Unique chat identifier.

title?: string

Chat title, if generated.

privacy: 'public' | 'private' | 'team' | 'team-edit' | 'unlisted'

Visibility setting of the chat.

createdAt: string

ISO timestamp of when the chat was created.

updatedAt?: string

ISO timestamp of when the chat was last updated.

authorId: string

ID of the user who created the chat.

vercelProjectId?: string

Associated Vercel project ID, if any.

metadata: Record<string, string>

User-defined key-value metadata.

writePermission: boolean

Whether the caller has write access to this chat.

cursor: string | null

Cursor to fetch the next page, or null if there are no more chats.

On this page